Skip to content

docs: sync account type fields with OpenAPI schemas#548

Merged
shreyav merged 1 commit into
mainfrom
docs/sync-20260604
Jun 4, 2026
Merged

docs: sync account type fields with OpenAPI schemas#548
shreyav merged 1 commit into
mainfrom
docs/sync-20260604

Conversation

@claude

@claude claude Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Updates documentation and Grid Visualizer to match recent OpenAPI schema changes for account types (BDT, COP, EGP, GHS, PKR).

Changes:

  • Mintlify docs: Add missing bankName field to Colombia (COP) mobile money example
  • Grid Visualizer: Update account-types.ts to match schema field requirements:
    • BDT_ACCOUNT: Add required bankName field
    • COP_ACCOUNT: Add required bankName and bankAccountType fields
    • EGP_ACCOUNT: Fix fields to match schema (iban for bank transfer, not accountNumber; remove non-existent swiftCode)
    • GHS_ACCOUNT: Add required bankName field
    • PKR_ACCOUNT: Reorder fields with bankName first (required for all rails, not just mobile money)

Related commits:

Test plan

  • Verify lint passes (make lint)
  • Review account field specs in Grid Visualizer match OpenAPI schemas
  • Verify COP mobile money example includes required bankName

🤖 Generated with Claude Code

Update documentation and Grid Visualizer to match recent schema changes:

- Add missing bankName field to COP mobile money example in docs
- Update Grid Visualizer account-types.ts:
  - BDT_ACCOUNT: add required bankName field
  - COP_ACCOUNT: add required bankName and bankAccountType fields
  - EGP_ACCOUNT: fix fields to match schema (iban for bank transfer, not accountNumber)
  - GHS_ACCOUNT: add required bankName field
  - PKR_ACCOUNT: reorder fields with bankName first (required for all rails)

Syncs with:
- bfdf3e7 chore: Sync account schemas (#546)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 4, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment Jun 4, 2026 9:27am

Request Review

@mintlify

mintlify Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview Jun 4, 2026, 9:29 AM

@greptile-apps

greptile-apps Bot commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR syncs the Grid Visualizer's account-types.ts and the Mintlify COP mobile-money example with the OpenAPI schemas introduced in #546. All field additions, removals, and reorderings across BDT, COP, EGP, GHS, and PKR were verified against the corresponding *AccountInfoBase.yaml schemas.

  • account-types.ts: bankName added as the leading required field for BDT, COP, EGP, GHS, and PKR; EGP corrected to use iban/phoneNumber only (dropping the non-existent accountNumber and swiftCode); COP gains bankAccountType; PKR gets bankName promoted to first position.
  • external-accounts.mdx: COP mobile-money cURL example now includes "bankName": "Nequi", matching the schema requirement. The accompanying <Note> still omits bankName from the mobile-money requirements list, leaving a minor inconsistency between the note text and the example above it.

Confidence Score: 4/5

Safe to merge — changes are documentation and visualizer data only, with no runtime logic affected.

All field changes in account-types.ts align with the OpenAPI base schemas. The only gap is in the COP Note block in external-accounts.mdx, which omits bankName from its mobile-money requirements prose while the example above it correctly includes it.

mintlify/snippets/external-accounts.mdx — the COP Note's description of mobile-money requirements should mention bankName alongside phoneNumber.

Important Files Changed

Filename Overview
components/grid-visualizer/src/data/account-types.ts Adds bankName as required first field to BDT, COP, EGP, GHS, and PKR account specs; fixes EGP to use iban (not accountNumber/swiftCode); adds bankAccountType to COP — all verified against the OpenAPI base schemas.
mintlify/snippets/external-accounts.mdx Adds required bankName field to COP mobile money example; the accompanying Note still states only phoneNumber is required for mobile money, creating an inconsistency with both the example and the schema.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[External Account Creation] --> B{Account Type}
    B --> BDT[BDT_ACCOUNT]
    B --> COP[COP_ACCOUNT]
    B --> EGP[EGP_ACCOUNT]
    B --> GHS[GHS_ACCOUNT]
    B --> PKR[PKR_ACCOUNT]

    BDT --> BDT_R[Required: bankName]
    BDT_R --> BDT_Rail{paymentRails}
    BDT_Rail --> |BANK_TRANSFER| BDT_BT[+ accountNumber]
    BDT_Rail --> |MOBILE_MONEY| BDT_MM[+ phoneNumber]

    COP --> COP_R[Required: bankName]
    COP_R --> COP_Rail{paymentRails}
    COP_Rail --> |BANK_TRANSFER| COP_BT[+ accountNumber + bankAccountType]
    COP_Rail --> |MOBILE_MONEY| COP_MM[+ phoneNumber]

    EGP --> EGP_R[Required: bankName]
    EGP_R --> EGP_Rail{paymentRails}
    EGP_Rail --> |BANK_TRANSFER| EGP_BT[+ iban]
    EGP_Rail --> |MOBILE_MONEY| EGP_MM[+ phoneNumber]

    GHS --> GHS_R[Required: bankName]
    GHS_R --> GHS_Rail{paymentRails}
    GHS_Rail --> |BANK_TRANSFER| GHS_BT[+ accountNumber]
    GHS_Rail --> |MOBILE_MONEY| GHS_MM[+ phoneNumber]

    PKR --> PKR_R[Required: bankName]
    PKR_R --> PKR_Rail{paymentRails}
    PKR_Rail --> |BANK_TRANSFER| PKR_BT[+ accountNumber]
    PKR_Rail --> |MOBILE_MONEY| PKR_MM[+ phoneNumber]
Loading

Comments Outside Diff (1)

  1. mintlify/snippets/external-accounts.mdx, line 223 (link)

    P2 The <Note> states that mobile money only requires phoneNumber, but bankName is also globally required per the COP schema (required: [accountType, bankName]). The example above the note now correctly includes bankName, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements.

    Prompt To Fix With AI
    This is a comment left during a code review.
    Path: mintlify/snippets/external-accounts.mdx
    Line: 223
    
    Comment:
    The `<Note>` states that mobile money only requires `phoneNumber`, but `bankName` is also globally required per the COP schema (`required: [accountType, bankName]`). The example above the note now correctly includes `bankName`, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements.
    
    
    
    How can I resolve this? If you propose a fix, please make it concise.

    Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
mintlify/snippets/external-accounts.mdx:223
The `<Note>` states that mobile money only requires `phoneNumber`, but `bankName` is also globally required per the COP schema (`required: [accountType, bankName]`). The example above the note now correctly includes `bankName`, but the note's prose leaves users who read it in isolation with an incomplete picture of mobile money requirements.

```suggestion
  Mobile money requires `bankName` (provider name, e.g., Nequi or Daviplata) and `phoneNumber` in international format (e.g., +573001234567).
```

Reviews (1): Last reviewed commit: "docs: sync account type fields with Open..." | Re-trigger Greptile

@shreyav shreyav merged commit 656f2b9 into main Jun 4, 2026
10 checks passed
@shreyav shreyav deleted the docs/sync-20260604 branch June 4, 2026 15:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant